Skip to content

Clearer difference with max and quiet options #18786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 28, 2023
Merged

Clearer difference with max and quiet options #18786

merged 1 commit into from
Aug 28, 2023

Conversation

flohw
Copy link
Contributor

@flohw flohw commented Aug 25, 2023

Hello,

First contribution here so I hope that I didn't made a mistake. Let me know if I need to change or point a process I missed.

As discussed on the symfony/symfony#46497, the difference between quiet and max may be unclear. In addition the behavior existing before 5.4 might have been erroneous. As the change is hard to retrieve and impossible to fix now, we come to the conclusion that a doc update may help to fix end user issue with this change.

Let me know if the added paragraph needs to be clearer or at another place or if it needs to be rephrased as English is not my first language. I also wanted to make a link to the section which talk about max and making tests fail. I hope this is the right way.

Thanks for reading. :-)

@carsonbot carsonbot added this to the 5.4 milestone Aug 25, 2023
@@ -325,6 +325,10 @@ It's also possible to change verbosity per deprecation type. For example, using
``quiet[]=indirect&quiet[]=other`` will hide details for deprecations of types
"indirect" and "other".

Note that `quiet` hides details for the specified deprecation types, but will
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note that `quiet` hides details for the specified deprecation types, but will
.. note::
`quiet` hides details for the specified deprecation types, but will

Please use 2 backticks before and after quite and max, thanks

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the two backticks while merging. I didn't add the .. note:: directive because this section is short and the directive breaks the reading flow. Thanks.

@OskarStark
Copy link
Contributor

cc @jmsche @greg0ire as you participate in the linked issue

@javiereguiluz javiereguiluz merged commit 6bd619a into symfony:5.4 Aug 28, 2023
@javiereguiluz
Copy link
Member

Florian, thanks and congrats on your first Symfony Docs contribution 🎉

@flohw flohw deleted the 5.4 branch September 4, 2023 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants